Spring Cloud Config采用数据库存储配置内容

在之前的《Spring Cloud构建微服务架构：分布式配置中心》一文中，我们介绍的Spring Cloud Server配置中心采用了Git的方式进行配置信息存储。这一设计巧妙的利用Git自身机制以及其他具有丰富功能的Git服务端产品，让Spring Cloud Server在配置存储和管理的上避开了很多与管理相关的复杂实现，使其具备了配置中心存储配置和读取配置的基本能力；而更上层的管理机制，由于不具备普遍适用性，所以Spring Cloud Server并没有自己去实现这部分内容，而是通过Git服务端产品来提供一部分实现，如果还需要更复杂的功能也能自己实现与定义。即便如此，对于Spring Cloud Server默认使用Git来存储配置的方案一直以来还是饱受争议。所以，本文将介绍一下Spring Cloud Config从Edgware版本开始新增的一种配置方式：采用数据库存储配置信息。

构建配置中心服务端

第一步：创建一个基础的Spring Boot项目，在pom.xml中引入几个主要依赖：

• spring-cloud-config-server：配置中心的基础依赖

• spring-boot-starter-jdbc：由于需要访问数据库，所以需要加载jdbc的依赖

• mysql-connector-java：MySQL数据库的连接包

• flyway-core：该内容非强制，主要用来管理schema（如果您不了解可以看一下这篇文章）

1. <parent>

2.    <groupId>org.springframework.boot</groupId>

3.    <artifactId>spring-boot-starter-parent</artifactId>

4.    <version>1.5.11.RELEASE</version>

5.    <relativePath/>

6. </parent>

7. <dependencies>

8.    <dependency>

9.        <groupId>org.springframework.cloud</groupId>

10.        <artifactId>spring-cloud-config-server</artifactId>

11.    </dependency>

12.    <dependency>

13.        <groupId>org.springframework.boot</groupId>

14.        <artifactId>spring-boot-starter-jdbc</artifactId>

15.    </dependency>

16.    <dependency>

17.        <groupId>org.flywaydb</groupId>

18.        <artifactId>flyway-core</artifactId>

19.        <version>5.0.3</version>

20.    </dependency>

21.    <dependency>

22.        <groupId>mysql</groupId>

23.        <artifactId>mysql-connector-java</artifactId>

24.        <version>5.1.21</version>

25.    </dependency>

26. </dependencies>

27. <dependencyManagement>

28.    <dependencies>

29.        <dependency>

30.            <groupId>org.springframework.cloud</groupId>

31.            <artifactId>spring-cloud-dependencies</artifactId>

32.            <version>Edgware.SR3</version>

33.            <type>pom</type>

34.            <scope>import</scope>

35.        </dependency>

36.    </dependencies>

37. </dependencyManagement>

第二步：准备schema创建文件。在 resources下创建 schema目录，并加入 V1__Base_version.sql文件，具体内容如下：

1. CREATE TABLE `properties` (

2.  `id` int(11) NOT NULL,

3.  `key` varchar(50) NOT NULL,

4.  `value` varchar(500) NOT NULL,

5.  `application` varchar(50) NOT NULL,

6.  `profile` varchar(50) NOT NULL,

7.  `label` varchar(50) NOT NULL,

8.  PRIMARY KEY (`id`)

9. ) ENGINE=InnoDB DEFAULT CHARSET=utf8;

该脚本会在程序运行时由flyway自动执行

第三步：创建应用主类，具体如下：

1. @EnableConfigServer

2. @SpringBootApplication

3. public class ConfigServerBootstrap {

4.    public static void main(String[] args) {

5.        ApplicationContext context = SpringApplication.run(ConfigServerBootstrap.class);

6.        // 测试用数据，仅用于本文测试使用

7.        JdbcTemplate jdbcTemplate = context.getBean(JdbcTemplate.class);

8.        jdbcTemplate.execute("delete from properties");

9.        jdbcTemplate.execute("INSERT INTO properties VALUES(1, 'com.didispace.message', 'test-stage-master', 'config-client', 'stage', 'master')");

10.        jdbcTemplate.execute("INSERT INTO properties VALUES(2, 'com.didispace.message', 'test-online-master', 'config-client', 'online', 'master')");

11.        jdbcTemplate.execute("INSERT INTO properties VALUES(3, 'com.didispace.message', 'test-online-develop', 'config-client', 'online', 'develop')");

12.        jdbcTemplate.execute("INSERT INTO properties VALUES(4, 'com.didispace.message', 'hello-online-master', 'hello-service', 'online', 'master')");

13.        jdbcTemplate.execute("INSERT INTO properties VALUES(5, 'com.didispace.message', 'hello-online-develop', 'hello-service', 'online', 'develop')");

14.    }

15. }

这里增加了一些测试用数据，以便于后续的配置读取验证。

第四步：配置 application.properties，具体内容如下：

1. spring.application.name=config-server-db

2. server.port=10020

3. spring.profiles.active=jdbc

4. spring.cloud.config.server.jdbc.sql=SELECT `KEY`, `VALUE` from PROPERTIES where APPLICATION=? and PROFILE=? and LABEL=?

5. spring.datasource.url=jdbc:mysql://localhost:3306/config-server-db

6. spring.datasource.username=root

7. spring.datasource.password=

8. spring.datasource.driver-class-name=com.mysql.jdbc.Driver

9. flyway.locations=/schema

这里主要涉及几个配置：

• spring.profiles.active=jdbc：必须设置，将配置中心的存储实现切换到jdbc的方式

• spring.cloud.config.server.jdbc.sql：非必须，这里由于采用mysql数据源， key、 value是保留关键词，原生的实现语句会报错，所以需要重写一下这句查询语句（如果存储的表结构设计不同于上面准备的内容，也可以通过这个属性的配置来修改配置的获取逻辑）

• spring.datasource.*：存储配置信息的数据源配置，这里采用mysql，开发者根据自己实际情况修改

• flyway.locations：flyway加载schema创建sql的位置

服务端配置验证

完成了上一节内容之后，我们就已经构建一个通过数据酷来存储配置内容的配置中心了，下面我们可以通过配置中心暴露的端点来尝试读取配置。

第一步：先将上面构建的配置中心启动起来。

第二步：验证配置信息获取：

• curl http://localhost:10020/config-client/stage/，获取信息 config-client服务 stage环境的配置内容，根据上面的数据准备，我们会获得如下返回内容：

1. {

2.    "name": "config-client",

3.    "profiles": [

4.    "stage"

5.    ],

6.    "label": null,

7.    "version": null,

8.    "state": null,

9.    "propertySources": [

10.        {

11.            "name": "config-client-stage",

12.            "source": {

13.            "com.didispace.message": "test-stage-master"

14.            }

15.        }

16.    ]

17. }

• curl http://localhost:10020/hello-service/stage/develop，获取信息 hello-service服务， stage环境， develop标签的配置内容，根据上面的数据准备，我们会获得如下返回内容：

1. {

2.    "name": "hello-service",

3.    "profiles": [

4.        "online"

5.    ],

6.    "label": "develop",

7.    "version": null,

8.    "state": null,

9.    "propertySources": [

10.        {

11.            "name": "hello-service-online",

12.            "source": {

13.                "com.didispace.message": "hello-online-develop"

14.            }

15.        }

16.    ]

17. }

关于如何访问Spring Cloud Config构建配置中心获取配置信息的详细内容 ，可以查看前文：《Spring Cloud构建微服务架构：分布式配置中心》，本文不做详细介绍。

总结

本文主要具体介绍了在Spring Cloud Config在Edgware版本开始新增的JDBC存储的使用思路，具体使用实际上还有很多可以优化的空间，比如：索引的优化、查询语句的优化；如果还需要进一步定制管理，对于表结构的优化也是很有必要的。

最后，安利一个基于Spring Cloud Config的配置管理项目：https://github.com/dyc87112/spring-cloud-config-admin，正在紧锣密鼓的开发中，尽情期待！

本文示例

读者可以根据喜好选择下面的两个仓库中查看 config-server-db和 config-client两个项目：

• Github：https://github.com/dyc87112/SpringCloud-Learning/

• Gitee：https://gitee.com/didispace/SpringCloud-Learning/

- END -

 往期推荐：

• 死磕Java系列：

……

• Spring系列：

……

可关注我的公众号

深入交流、更多福利

扫码加入我的知识星球

点击“阅读原文”，看本号其他精彩内容